vcSimInterfaceSection

vcSimInterfaceSection is a collection of connector fields in an interface.

See in: Overview

Parent: vcObject

Children -

Referenced by: vcOneToManyInterface.Sections, vcOneToManyInterface.createSection(), vcSimInterface.ConnectedFromSections, vcSimInterface.ConnectedToSections, ... (see more)

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
ConnectedToSection	vcSimInterfaceSection	R	Gets a section connected to the section. If section is not connected, value is None.
Fields	vcList[vcSimInterfaceField]	R	Gets all interface fields in this section.
Frame	vcFrameFeature	RW	Gets or sets frame feature that defines physical position of this section. Exceptions: RuntimeError: When trying to modify a connected interface.
Index	Integer	RW	Gets or sets the zero-based index of this section in the interface. See more Exceptions: IndexError: When assigning a negative value. RuntimeError: When trying to modify a connected interface.
Interface	vcSimInterface	R	Gets the interface this section is in.
Name	String	RW	Gets or sets name of section. The name doesn't have to be unique. Exceptions: RuntimeError: When trying to modify a connected interface.

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
createField	vcSimInterfaceField	vcSimInterfaceFieldType fieldType, String name	Creates a new interface field of the given type to this section. See more Parameters: fieldType (vcSimInterfaceFieldType): The type of field to create. name (str): Field name to assign. Empty string is replaced with "Unnamed". Returns: vcSimInterfaceField: The created interface field object. Exceptions: ValueError: When given the field type is not supported by this interface. RuntimeError: When trying to modify a connected interface.
delete	None	None	Deletes this interface section. Exceptions: RuntimeError: When trying to modify a connected interface.